# New part entry in the documentation

# Meta

• Assigned to: jurra
• Category: use case
• Column: todo
• Creation time: 2019-08-22 08:10:20 (UTC)
• Type: note

# Description

General description of how a new metadata of part is recorded in the project.

# Details

# New part entry in documentation project

General description of how a new metadata of part is recorded in the project.

# Use case description

1. User creates a CAD model.

2. Automated response by adding a template file that respects the schema of part.

3. User fills in the template that has been created with data about the part. (this can be a form or not). Ideally should be a form. 3.1. The form can also be registered in the yaml file, and the yaml file can be regenerated from the json. 3.2. In case there is an entry to an object that doesn't come from the yaml file, then the yaml file will be recreated from the manifest.

4. Once the template-form-data is saved in the file the manifest is updated. 4.1. Additionally or complementary if there is a commit of the file then githooks can be used to automatically update the manifest.

   • [ ] This implies a script that checks and validates with the json schema if the data has been correctly updated.

   We will be making CRUD operations at this level already.

4.2. Another variant is that the user runs a command everywhile and then.

---

^{This document was generated by Visual Studio Code extension vscode-kanban.}